You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixed static descriptions handling for composite tests by combining docstrings from individual unit metrics. Previously, this was throwing an error in the notebook run_unit_metrics.ipynb as it was assuming a non-existing test_id for composite unit metrics tests. Now the docstring is built from a combination of the docstrings of the individual unit metrics.
This pull request introduces an enhancement to the validmind/tests/run.py file, specifically in the _run_comparison_test function. The change improves the generation of test documentation by checking if unit_metrics are present. If they are, it constructs a detailed documentation string by iterating over each unit_metric, retrieving its name and documentation, and joining them with newlines. If unit_metrics are not present, it defaults to the previous behavior of loading the documentation for the test_id. This enhancement allows for more comprehensive documentation when multiple unit metrics are involved in a test.
The version number in pyproject.toml and validmind/__version__.py has been incremented from 2.7.1 to 2.7.2 to reflect this change.
Test Suggestions
Test the _run_comparison_test function with a non-empty unit_metrics list to ensure the documentation is generated correctly for each metric.
Test the _run_comparison_test function with an empty unit_metrics list to verify that it falls back to the original behavior.
Verify that the output format of the documentation string is as expected when multiple unit metrics are provided.
Check for any performance impacts when processing a large number of unit metrics.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bugSomething isn't workinginternalNot to be externalized in the release notes
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Internal Notes for Reviewers
Fixed static descriptions handling for composite tests by combining docstrings from individual unit metrics. Previously, this was throwing an error in the notebook
run_unit_metrics.ipynbas it was assuming a non-existingtest_idfor composite unit metrics tests. Now the docstring is built from a combination of the docstrings of the individual unit metrics.External Release Notes